smartposapi-core/com.worldline.smartposapi.core.dto

Package-level declarations

Types

data class ActiveNetwork(val ssid: String?, val interfaceName: String?, val ipv4: String?, val subnetMask: String?, val gateway: String?, val macAddress: String?) : Parcelable

Represents the active network values.

AdvertisingResult

data class AdvertisingResult(val status: AdvertisingStatus, val message: String? = null) : Parcelable

AdvertisingStatus

enum AdvertisingStatus : Enum<AdvertisingStatus> , Parcelable

Apn

data class Apn(val carrierName: String?, val apnName: String?, val apnUsername: String? = "", val apnPassword: String? = "", val serverAddress: String? = "", val authenticationType: String? = "", val apnType: String? = "", val countryCodes: String? = "", val mobileNetworkCodes: String? = "") : Parcelable

Holds the data related to a specific device APN.

ApnStatus

enum ApnStatus : Enum<ApnStatus> , Parcelable

BatteryStatus

data class BatteryStatus(val charging: Boolean, val percent: Float = 100.0f) : Parcelable

A data object used for holding the current battery status

CPUStats

data class CPUStats(val upTime: Int, val processes: Int, val usage: Float) : Parcelable

A data object used for holding the CPU stats

DeviceMode

enum DeviceMode : Enum<DeviceMode> , Parcelable

Provides the device mode the current SPAPI service is running on. This can be used to determine if the device is running as a development device or a production device as per device manufacturer configurations. This does not always correspond to debug application or release application and should be used instead of the BuildConfig constants to determine the current state.

ExtendedPrinterStatus

data class ExtendedPrinterStatus(val status: ExtendedStatus, val statusCode: Int) : Parcelable

ExtendedStatus

enum ExtendedStatus : Enum<ExtendedStatus> , Parcelable

Feature

enum Feature : Enum<Feature> , Parcelable

Contains the Features that will be returned when the client is requesting the list of avialable features in FeatureCheck.getAvailableFeatures. Each feature can correspond to either the support of a whole service or a specific functionality of a service.

ImageProperties

data class ImageProperties(val canvasHeight: Int? = null, val imageWidth: Int? = null, val imageHeight: Int? = null, val startDrawPositionX: Int? = null, val startDrawPositionY: Int? = null) : Parcelable

A data class that holds the info to the image properties, if null, then the existing layout properties of the passed image will be taken.

ImageSource

data class ImageSource(val imagePath: String? = null, val imageContentProviderUrl: String? = null, val imageByteArray: ByteArray? = null) : Parcelable

A data class that holds the info for the image source. If more than 1 image source defined, then the first defined image source in this data class will be taken.

MemoryStats

data class MemoryStats(val storages: List<MemoryStats.Usage>) : Parcelable

MemoryStats contains a summary of the current RAM usage as well as a list of storage devices with their corresponding usage data.

NetworkInfo

data class NetworkInfo(val activeNetwork: ActiveNetwork? = null, val wifi: List<NetworkInterface> = emptyList(), val ethernet: List<NetworkInterface> = emptyList()) : Parcelable

The NetworkInfo will contain a list of the wifi and ethernet interfaces as well as the information of the currently active network. Due to the fact that the network info can only be obtained on the active network, the active network info is provided separately from the network interfaces.

NetworkInterface

data class NetworkInterface(val name: String?, val macAddress: String?, val connected: Boolean = false, val ipv4: String?) : Parcelable

A network interface represents the hardware interface information of a network device.

PrintBarcodeObject

data class PrintBarcodeObject(val contents: String? = null, val barcodeFormat: String? = null, val printBarcodeProperties: PrintBarcodeProperties? = null) : PrintObject

A data class that holds the info for the Barcode object to be printed.

PrintBarcodeProperties

data class PrintBarcodeProperties(val canvasHeight: Int? = null, val barcodeWidth: Int? = null, val barcodeHeight: Int? = null, val startDrawPositionX: Int? = null, val startDrawPositionY: Int? = null) : Parcelable

A data class that holds the layout properties for the barcode.

PrintEmptyLines

data class PrintEmptyLines(val amountOfEmptyLines: Int, val lineHeight: Int) : PrintObject

A data class representing a print request to print empty lines based on paper width.

PrintErrorType

enum PrintErrorType : Enum<PrintErrorType> , Parcelable

PrinterStatus

enum ~~PrinterStatus~~ : Enum<PrinterStatus> , Parcelable

PrintImageObject

data class PrintImageObject(val imageSource: ImageSource? = null, val imageProperties: ImageProperties? = null) : PrintObject

A data class that holds the info for the Image object to be printed.

PrintLeftRightObject

data class PrintLeftRightObject(val printLineObjectLeft: PrintLineObject, val printLineObjectRight: PrintLineObject) : PrintObject

A data class representing a print request to print two texts on the same line, aligned left and right. The layout properties can be specified independently for both the left and right texts.

PrintLineObject

data class PrintLineObject(val data: String? = null, val printLineProperties: PrintLineProperties? = null) : PrintObject

A data class that holds the info for the object to be printed. Only data is mandatory, the other properties are optional. When only data passed a default layout settings depending on device will be taken.

PrintLineProperties

data class PrintLineProperties(val fontSize: Int? = null, val typeface: String? = null, val textAlignment: String? = null, val isBold: Boolean? = null, val isItalic: Boolean? = null, val isUnderline: Boolean? = null) : Parcelable

A data class that holds the info to the print line properties, if null, then default properties will be taken depending on device.

PrintListOfLines

data class PrintListOfLines(val listOfLines: List<PrintLineObject>) : PrintObject

A data class representing a print request to print a list of lines based on paper width. The list of lines is provided as a list of PrintLineObject instances, each representing a single line to print. If the data exceeds the maximum characters allowed on one line, a PrintResult failure will be returned.

PrintObject

open class PrintObject : Parcelable

A base data class representing a print object.

PrintResult

data class PrintResult(val status: Status, val message: String? = null) : Parcelable

An data class that holds the result of the print operation

Sim

data class Sim(val slotId: String, val imei: String? = null, val apns: List<Apn> = arrayListOf()) : Parcelable

A sim card slot for the current device

Status

enum Status : Enum<Status> , Parcelable

WIPAddress

data class ~~WIPAddress~~(val interfaceName: String, val address: String?) : Parcelable